.. _cmlPmHomeGetPosClrMode:

cmlPmHomeGetPosClrMode 
================================
--------------------------------


SYNOPSYS
`````````````
.. code-block:: none

  VT_I4 cmlPmHomeGetPosClrMode ([in] VT_I4 BoardID, [in] VT_I4 NodeId, [in] VT_I4 Channel, [out] VT_PI4 PosClrMode )                

DESCRIPTION
`````````````  

- cmlPmHomeSetPosClrMode()/cmlPmHomeGetPosClrMode() 함수는 원점 복귀 이송 완료 후에 발생하는 
  모션 컨트롤러와 서보 드라이브간의 제어 편차에 의해 발생하는 입력 펄스(Feedback pulse) 처리 방법을 
  설정 및 설정 상태를 반환합니다. 

\

- 이 함수의 사용과 호출에 있어, 제공된 ㈜커미조아의 함수 헤더 Visual Basic 에서는 함수의
  첨두어 cms 가 붙지 않습니다.


PARAMETER
`````````````

▶ BoardID : 사용자가 설정한 디바이스(보드) ID. 

▶ NodeId : 사용자가 제어하고자 하는 노드 번호. 
 
▶ Channel : 축(채널) 번호. 축번호는 상수값으로 0번째 채널을 기준 채널로 임의의 채널을 
설정할 수 있습니다. 
 
▶ PosClrMode : cmlPmHomeSetPosClrMode함수의 인자이며, 원점복귀가 완료된 후에 Command 
및 Feedback 위치가 클리어되는 모드를 결정하는 매개 변수(媒介變數)입니다. PosClrMode는 
다음과 같습니다. 

  .. csv-table::
   :widths: 10 90
   :header-rows: 1
   :stub-columns: 0

    Value, Meaning
    -1(cmlHPCM_DISABLE), 원점 복귀 클리어 모드를 사용하지 않습니다.
    "| 0(cmlHPCM_M0)", "
     |               최종 완료 조건에 해당하는 외부 하드웨어 신호가 입력되는 순간에 
     |               Command 및 Feedback의 위치가 0으로 소거됩니다. 일정량의 Feedback  
     |               위치 편차를 보입니다."
    "| 1(cmlHPCM_M1)","
     |               원점복귀 모드에 상관없이 하드웨어 신호의 입력 상태와 더불어 소프트웨어
     |               적인 모션 완료 확인 동작을 포함한, 전체적인 원점복귀 작업이 모두 완료된
     |               후에 Command 와 Feedback 위치가 모두 자동으로 0으로 소거됩니다.  
     |               일정량의 Feedback 위치 편차를 보입니다."    
    "| 2(cmlHPCM_M2)","
     |               1차적으로는 cmHPCM_M0 일 때와 동일하게 동작합니다. 단, 원점복귀가
     |               완료된 후에 Feedback 위치와 동일한 값으로 Command 위치를 셋팅하므로써
     |               Command 와 Feedback 을 일치하도록 동작합니다. 이를 통해 서보드라이브에서 
     |               실제 이송한 위치에 대한 양을 Command 위치에 반영시켜서,
     |               다음 모션 동작을 수행할 수 있도록 합니다." 

RETURN VALUE
`````````````

.. csv-table::
  :widths: 10 90
  :header-rows: 1
  :stub-columns: 0

  Value, Meaning
  음수, 수행 실패
  ERR_NONE, 수행 성공

REFERENCE
`````````````

.. image:: ../../../res/15-11.jpg

.. image:: ../../../res/15-12.jpg

EXAMPLE
`````````````

.. code-block:: c++
 :linenos:
 :emphasize-lines: 5

  C/C++ 
  #include “ComiMLink2_SDK.h” 
  #include “ComiMLink2_SDK_Def.h” 
  long BoardID = 0; 
  long nPosClrMode = 0; 
  //0번 축을 원점복귀 완료 시 Command, Feedback 일치 모드로 사용합니다. 
  cmlPmHomeSetPosClrMode (BoardID, 0, ccmlX1, ccmlHPCM_M2 ); 
  //0번 축에 설정된 Position Clear Mode를 반환합니다. 
  cmlPmHomeGetPosClrMode (BoardID, 0, ccmlX1, &nPosClrMode );